Delete Service

The Delete Service deletes specific service.

URI

Copy 
{{baseUrl}}/api/v2/customer/{CustomerGuid}

HTTP Method

DELETE

Request Headers

You can alternatively specify either of the following headers, both of which return identical output.

Attribute

Type

Description

X-Ovoc-Channel-Id

integer

The Live Platform channel id. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

X-IAM-Account-Id

string

The Live Platform iamAccountId of the channel. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

Request Parameters

Parameter

Type

Description

CustomerGuid

string ($uuid)

The umpCustomerGuid created in the Live Platform customer tenant SQL database :

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

allDetails

boolean

Default: false

When enabled retrieves the Site Locations array (SIP Connections) for the specific customer.

Example Response

Example of a response for a request without allDetails or allDetails=false in query string:

HTTP Responses

■ 200 OK
Copy 
1
■ 403 Forbidden: This error is raised when the CustomerGuid specified in the Request parameter does not belong to the channel specified in the Request header.

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk"

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 404 Not Found:

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk"

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 500 Internal Server Error